home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / statz410.zip / STATZ.DOC < prev    next >
Text File  |  1992-04-02  |  51KB  |  1,058 lines
  1.   -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  2.                                  STATZ
  3.                               Version 4.10
  4.                            By Michael W. Miles
  5.                            OLD HIPPIE SOFTWARE
  6.                     (714) 653-4802  1200 - 19200 HST
  7.                     -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  8.  
  9.               ::::::::::[ What's STATZ, anyhow? ]::::::::::
  10.  
  11. STATZ is the DEFINITIVE USER STATS door written for Searchlight BBS software.
  12.    STATZ can also be used to PROGRAM YOUR OWN SLBBS command replacements.
  13.  
  14.  
  15.    Features in this version of STATZ include:
  16.  
  17.    All output uses SLBBS-type flow control!
  18.    Control-C and SPACEBAR aborting as well as CONTROL-S pause mode.
  19.    SLBBS-type flow control can be toggled at will and at any userlevel you
  20.    choose!
  21.  
  22.    All output is correct to the CALLER while maintaining color on color
  23.    monitors on the Sysop's end.  Monochrome Ansi callers get MONOCHROME ANSI
  24.    while you still have color.  TTY callers get TTY output while you still
  25.    have color locally.  All inverse type and blinking type is displayed
  26.    correctly to TTY and Monochrome Ansi callers.  If you have a Monochrome
  27.    monitor locally, then output is correct for YOUR end while maintaining
  28.    correct output for all callers.
  29.  
  30.    Statz uses your configuration info for it's own inactivity timer.  Statz
  31.    will automatically exit back to the bbs after it's timer has zero'd out.
  32.  
  33.    Statz automatically exits completely back to SLBBS upon completion.  If
  34.    used as a DOOR, no "Press a key to return to Searchlight" is displayed
  35.    and Statz doesn't wait or prompt the user to return to the BBS.  If
  36.    you require a delay or need to wait for a user to read the screen, simply
  37.    use delay codes or one of the codes that wait for a carriage return.
  38.  
  39.    The following SYSOP HOT KEYS are supported in STATZ
  40.  
  41.    ALT-A = SYSOP CHAT AVAILABILITY FLAG TOGGLE           (REGISTERED)
  42.    ALT-N = SYSOP NEXT FLAG TOGGLE                        (REGISTERED)
  43.    ALT-S = SUPERUSER FLAG TOGGLE                         (REGISTERED)
  44.    ALT-X = EXIT STATZ and then EXIT SLBBS                (REGISTERED)
  45.    ATL-Z = EXIT STATZ                                    (REGISTERED)
  46.    F8    = SCROLL STATUSLINE
  47.    F9    = INCREASE ONLINE CALLER'S TIME 5 MINUTES       (REGISTERED)
  48.    F10   = DECREASE ONLINE CALLER'S TIME 5 MINUTES       (REGISTERED)
  49.  
  50.  
  51.    Statz is FULLY configurable by the Sysop.  All output from STATZ is
  52.    pulled into STATZ from STATZ.TXT, a standard text file.  STATZ.TXT can
  53.    include ANY and ALL SLBBS ANSI EDITOR OUTPUT codes, including blink,
  54.    inverse, and normal.  They will work in STATZ exactly as they do in
  55.    Searchlight, so you can use your SLBBS editor to preview your screens!
  56.    STATZ also features STATZ CODES - a series of special codes that display
  57.    system/user information anywhere on your screen (and your user's) with
  58.    all the ease and simplicity of SLBBS color codes. You can even configure
  59.    IN STATZ.TXT how much you want to be displayed.  Multiple screen output
  60.    is supported with the Press [RETURN]: STATZ code and the screen clear
  61.    code.  YOU choose exactly what happens where and what you see is what
  62.    the user sees.  STATZ has no limit on the size of your STATZ.TXT or
  63.    replacement output file. (Replacement output file available to registered
  64.    sysops only)
  65.  
  66.    Statz also allows you to decide how STATZ can be aborted!  If you choose
  67.    you can FORCE all or PART of STATZ output on the online caller.
  68.    You can also choose (via STATZ codes) if STATZ will totally abort
  69.    or abort to your next screen!  Registered users can set abort/flow
  70.    levels so one output file works differently for different caller levels.
  71.    Statz can even hang up the phone, and do it based on baud rate, bbs level,
  72.    or config.sl2 Sysop defined level groups!
  73.  
  74. ::::::::::[ Setting up STATZ ]::::::::::
  75.  
  76.    Setting up STATZ is a breeze!
  77.  
  78.    STATZ requires little actual thought on the part of the installer, and
  79.    STATZ was designed to be that way-- isn't the fussy stuff what the
  80.    programmer is supposed to take care of?
  81.  
  82.   Simply place STATZ.EXE anyplace you like on your drives or ram disk.
  83.   Also install STATZ.CNF and STATZ.TXT in the SAME DIRECTORY as STATZ.EXE.
  84.   STATZ will use the information found in the CONFIG.SL2 file for each node
  85.   it's being used on to do it's job!  Only 1 copy of STATZ.EXE is needed
  86.   for ANY NUMBER of NODES. Only 1 copy of STATZ.EXE is needed for ANY NUMBER
  87.   of NODES - got that? If you require more than one copy to get it working,
  88.   then you did something WRONG.
  89.  
  90.   The REGISTERED version of STATZ will allow you to define a replacement
  91.   for STATZ.TXT on the command line for use when chaining STATZ in a
  92.   batch file, replacing internal SLBBS commands (SL 2.25), or allowing
  93.   for using STATZ different ways in different places on your BBS.
  94.  
  95. ::::::::::[ The STATZ.CNF File ]::::::::::
  96.  
  97.    The format of the STATZ.CNF file is a breeze to follow... all lines that
  98.    start with a '#' character are COMMENTS.  You can add to them or delete
  99.    them at will... make notes for when you're sober or whatever.
  100.  
  101.    The following parameters are necessary for STATZ to operate:
  102.  
  103. NAME=
  104. LEVEL=
  105. KEY=
  106. SLBBS=
  107. BBS=
  108. SOUND=
  109.  
  110. All of the above parameters MUST MUST MUST start at the left-most column
  111. of the STATZ.CNF text file.
  112.  
  113. For UNREGISTERED versions of STATZ the following is recommended..
  114.  
  115. NAME=UNREGISTERED
  116. LEVEL=D
  117. KEY=000000000000
  118. SLBBS=0000
  119. BBS=(your bbs name)
  120.  
  121. FILES=(your text string)
  122. FILES2=(your text string)
  123. ANSI1=(your text string)
  124. ANSI2=(your text string)
  125. ANSI3=(your text string)
  126. MODE1=(your text string)
  127. MODE2=(your text string)
  128. MODE3=(your text string)
  129. PROTO1=(your text string)
  130. PROTO2=(your text string)
  131. PROTO3=(your text string)
  132. PROTO4=(your text string)
  133. MONTH1=(your text string)
  134. MONTH2=(your text string)
  135. MONTH3=(your text string)
  136. MONTH4=(your text string)
  137. MONTH5=(your text string)
  138. MONTH6=(your text string)
  139. MONTH7=(your text string)
  140. MONTH8=(your text string)
  141. MONTH9=(your text string)
  142. MONTH10=(your text string)
  143. MONTH11=(your text string)
  144. MONTH12=(your text string)
  145. LOCAL1=(your text string)
  146.  
  147. For REGISTERED versions (if you paid you got one!) set it up like this..
  148.  
  149. NAME=(the name you used on your ORDER FORM to us)
  150. LEVEL=R
  151. KEY=(Your registration number)
  152. SLBBS=(The first 4 digits of your SLBBS registration number)
  153. BBS=(Your Board's name - as per your ORDER FORM to us)
  154. SOUND=(YES or NO)
  155. FILES=(your text string)
  156. FILES2=(your text string)
  157. ANSI1=(your text string)
  158. ANSI2=(your text string)
  159. ANSI3=(your text string)
  160. MODE1=(your text string)
  161. MODE2=(your text string)
  162. MODE3=(your text string)
  163. PROTO1=(your text string)
  164. PROTO2=(your text string)
  165. PROTO3=(your text string)
  166. PROTO4=(your text string)
  167. MONTH1=(your text string)
  168. MONTH2=(your text string)
  169. MONTH3=(your text string)
  170. MONTH4=(your text string)
  171. MONTH5=(your text string)
  172. MONTH6=(your text string)
  173. MONTH7=(your text string)
  174. MONTH8=(your text string)
  175. MONTH9=(your text string)
  176. MONTH10=(your text string)
  177. MONTH11=(your text string)
  178. MONTH12=(your text string)
  179. AVAIL1=(your text string)
  180. AVAIL2=(your text string)
  181. LOCAL1=(your text string)
  182. EURODATE=(YES or NO)
  183.  
  184.    The registration number you receive from us will use several of the above
  185.    pieces of information in it's creation.  Please take care when filling out
  186.    the ORDER FORM so as to save yourself (and US!) some grief.
  187.    Also note that the information MUST match exactly.  If, for instance,
  188.    your BBS name is VORTEX and VORTEX is what you have entered in your
  189.    SLBBS configuration file, then using VORTEX BBS in STATZ.CNF will
  190.    cause STATZ to -=[ NOT RUN ]=-.
  191.    Note that the BBS name is taken DIRECTLY from the STATZ.CNF file for
  192.    displaying the stats for the user if you're registered. No biggy, but it
  193.    does and I'm telling you so.  This applies to both the registered and
  194.    unregistered operation modes.
  195.  
  196.    The SOUND= parameter is available to ALL STATZ users.
  197.    SOUND=YES or SOUND=NO toggles the tri-tone bell when STATZ is run.
  198.  
  199.    The FILES= parameter is available to all STATZ users.
  200.    FILES=(text string) will display (text string) when a user has no
  201.    file transfer ratio.
  202.  
  203.    The FILES2= parameter is available to all STATZ users.
  204.    FILES2=(text string) will display (text string) instead of ' to 1'
  205.    when showing a user's file transfer ratio and the user has anything
  206.    but a 0:1 ratio allowable on your system.  The MAIN reason for this
  207.    parameter is for NON-ENGLISH SLBBS systems to be able to use STATZ.
  208.  
  209.    The ANSI1= parameter is available to all STATZ users.
  210.    ANSI1=(text string) will display (text string) instead of 'MONOCHROME'
  211.    when the online user is in Monochrome Ansi mode.  Useful for
  212.    NON-ENGLISH STATZ output.
  213.  
  214.    The ANSI2= parameter is available to all STATZ users.
  215.    ANSI2=(text string) will display (text string) instead of 'ANSI COLOR'
  216.    when the online user is in Color Ansi mode.  Useful for
  217.    NON-ENGLISH STATZ output.
  218.  
  219.    The ANSI3= parameter is available to all STATZ users.
  220.    ANSI3=(text string) will display (text string) instead of 'NONE'
  221.    when the online user is in TTY mode.  Useful for NON-ENGLISH STATZ output.
  222.  
  223.    The MODE1= parameter is available to all STATZ users.
  224.    MODE1=(text string) will display (text string) instead of 'GENERIC'
  225.    when the online user is using Generic ANSI mode.  Useful for
  226.    NON-ENGLISH STATZ output.
  227.  
  228.    The MODE2= parameter is available to all STATZ users.
  229.    MODE2=(text string) will display (text string) instead of 'TELIX / PROCOMM'
  230.    when the online user is in PROCOMM ANSI mode.  Useful for NON-ENGLISH
  231.    STATZ output.
  232.  
  233.    The MODE3= parameter is available to all STATZ users.
  234.    MODE3=(text string) will display (text string) instead of 'STANDARD'
  235.    when the online user is in Standard ANSI mode.  Useful for NON-ENGLISH
  236.    STATZ output.
  237.  
  238.    The PROTO1= parameter is available to all STATZ users.
  239.    PROTO1=(text string) will display (text string) instead of 'NONE'
  240.    when the online user has not yet selected a default protocol.  Useful
  241.    for NON-ENGLISH STATZ output.
  242.  
  243.    The PROTO2= parameter is available to all STATZ users.
  244.    PROTO2=(text string) will display (text string) instead of 'Xmodem'
  245.    when the online user's default protocol is Xmodem.  Useful for
  246.    NON-ENGLISH STATZ output.
  247.  
  248.    The PROTO3= parameter is available to all STATZ users.
  249.    PROTO3=(text string) will display (text string) instead of 'Xmodem/CRC'
  250.    when the online user's default protocol is Xmodem CRC.  Useful for
  251.    NON-ENGLISH STATZ output.
  252.  
  253.    The PROTO4= parameter is available to all STATZ users.
  254.    PROTO4=(text string) will display (text string) instead of 'Xmodem/1k'
  255.    when the online user's default protocol is 1k Xmodem.  Useful for
  256.    NON-ENGLISH STATZ output.
  257.  
  258.    The MONTH1= parameter is available to all STATZ users, as are all the
  259.    MONTHx= parameters.  The MONTHx= parameters allow you to redefine the
  260.    names of the months in any language.  Note that only 9 characters are
  261.    allowed per month name.  If the MONTHx= parameters are not present
  262.    in your STATZ.CNF file then the default English upper and lower case
  263.    strings will eb output.  Usefule for both NON-ENGLISH STATZ output
  264.    as well as defining month names in all caps or whatever..
  265.  
  266.    The AVAIL1= and AVAIL2= parameters define the text to be output when the
  267.    \FA code is used.  The \FA code is available ONLY to registered Statz
  268.    users.  The AVAIL1= defined string will be output IF the SYSOP IS NOT
  269.    AVAILABLE.  The AVAIL2= defined string will be output IF the SYSOP IS
  270.    AVAILABLE.  These two defined strings will override the internal \FA
  271.    output strings of NOT for not available and "" (nothing) for AVAILABLE
  272.    IF they are defined.
  273.  
  274.    The LOCAL1= parameter defines a text string to be output if the \%B code
  275.    or \XF code finds a local login.  Primarily for non-English STATZ use.
  276.    Use of the LOCAL1= parameter overrides the internal defaults for these
  277.    codes.
  278.  
  279.    The EURODATE= parameter defines whether or not the EXPIRATION DATE is
  280.    output in USA (MM-DD-YY) or EUROPEAN (DD-MM-YY) format.  If this parameter
  281.    is not defined then USA format is the default.  Defined as EURODATE=NO
  282.    also uses USA date format.  Defined as EURODATE=YES will cause the \FC
  283.    code to use the European date format.
  284.  
  285. ::::::::::[ Using STATZ as a standard DOOR ]::::::::::
  286.  
  287.    The DOORS.DEF file entry to use STATZ on SLBBS is as follows:
  288.  
  289. 1;0;1;LEVEL;STATZ - USER STATISTICS;.;PATH\STATZ.EXE  (optional parameter)(L)
  290.  
  291.  
  292.    The first instance of 1 in the above string can be replaced by a 2 if
  293.    you're using a monochrome monitor locally.
  294.  
  295.    The second parameter MUST be 0 as STATZ does disk tricks that SLBBS cannot
  296.    tell from a disk write. No disk writes take place, but you WILL get a
  297.    DRIVE NOT READY DOS error (at least under my DOS 4.01 and 5.0) unless you
  298.    set this parameter to 0.
  299.  
  300.    The second 1 in the DOORS.DEF entry tells SLBBS how to abort in case of
  301.    carrier. STATZ does NOT monitor the line, so a 1 is necessary to have
  302.    SLBBS do all the work in this area.
  303.  
  304.    LEVEL is for you to enter the minimum access level necessary to access
  305.    STATZ. 0 to 255 will be valid entries in this area.
  306.  
  307.    As far as the "STATZ - USER STATISTICS", call it whatever you like!
  308.  
  309. ::::::::::[ IMPORTANT! ]::::::::::
  310.  
  311.    Next is the DIRECTORY that will be made CURRENT before executing STATZ.EXE.
  312.    It MUST BE either . ( a period ) or the path string that points to your
  313.    CONFIG.SL2 file. STATZ will find your other .BBS files after reading your
  314.    CONFIG.SL2.
  315.  
  316.  
  317.    The last entry in the DOORS.DEF string is the path of the STATZ.EXE file
  318.    It can be ANYWHERE on any drive, ramdisk, etc.
  319.  
  320.    The Optional Parameter allows REGISTERED Statz users to NAME a replacement
  321.    for STATZ.TXT.  For example you wish to have STATZ run several copies
  322.    of itself strung together in a batch file you can now call
  323.    STATZ.EXE aaa or STATZ.EXE zzz and STATZ will use aaa.txt or
  324.    zzz.txt instead of STATZ.TXT.  Note that aaa.txt and zzz.txt are
  325.    examples only and that you are only limited to a maximum of 7 characters
  326.    (any 7 or less characters allowable by DOS in filenames) in your
  327.    file names.  This is also nice in the case that you only want ONE copy
  328.    of STATZ.EXE and STATZ.CNF on the drive but want to use STATZ in
  329.    different ways in different places on your BBS.  STATZ will read in
  330.    the Optional Parameter and add a .TXT suffix to it to find it's
  331.    new default filename.
  332.  
  333.    The 'L' command line parameter may be used with the Optional Parameter
  334.    or alone.  If it is used WITH the Optional Parameter then it must FOLLOW
  335.    the Optional Parameter on the command line.  The L is the LEVEL switch
  336.    and is available ONLY to REGISTERED STATZ users.  If The L parameter
  337.    is used then STATZ will display an output file designed ONLY for
  338.    callers that match a level you have defined in your config.sl2 file.
  339.    For example if a caller matches your 'B' level settings for BBS level
  340.    AND Files level AND Attributes then STATZ looks for a file in the
  341.    directory STATZ is located in named STATZB.TXT and displays it through
  342.    STATZ instead of STATZ.TXT.  This follows true for ALL defined levels
  343.    on your BBS. If a caller matches your 'A' settings then STATZA.TXT is
  344.    looked for and used.. .   So STATZ can easily display a different
  345.    message for EVERY user level you have defined!  If a defined level
  346.    file is not found by STATZ then it will default to STATZ.TXT.
  347.  
  348.    If you use both the Optional Parameter and the L switch and a caller
  349.    matches one of your pre-defined levels in your config.sl2 then the
  350.    following will happen:
  351.  
  352.    STATZ.EXE ORANGES L   <---- our example command line
  353.  
  354.    STATZ will look for ORANGESA.TXT if the online caller is level 'A'.
  355.    STATZ will look for ORANGESB.TXT if the online caller is level 'B'.
  356.    and so on and so forth....
  357.  
  358.    If you use both the Optional Parameter and the L switch then IF a caller
  359.    doesn't match any of your pre-defined levels in your config.sl2 the file
  360.    that you defined with the Optional Parameter will be displayed.  If you
  361.    use the L switch alone then STATZ.TXT will be displayed if the online
  362.    caller doesn't match any of your pre-defined levels.
  363.  
  364.  
  365. ::::::::::[ Setting up STATZ as an AUTO-DOOR ]::::::::::
  366.  
  367. Simply fill in the blanks in you autodoor input fields thusly:
  368.  
  369. AutoDoor Command............. PATH\STATZ.EXE (Optional Parameter)(L)
  370. Directory Path............... Your path to config.bbs for THIS NODE(!)
  371. Communications Support....... Standard
  372. Abort Method................. Terminate
  373. Write Protection............. No - MUST BE NO even though STATZ does no
  374.                                    disk writes!
  375.  
  376.  ::::::::::[ STATZ.TXT INFORMATION ]::::::::::
  377.  
  378.  
  379.    Enclosed in the .ZIP file STATZ arrived to you in is a sample STATZ.TXT
  380.    file you can use to get an idea of what's happening here.
  381.    The STATZ.TXT file is limited to 100 lines of text with a 255 character
  382.    per line limit.  Obviously 255 characters won't be output.. but it was
  383.    allowed because SLBBS and STATZ codes are not counted in the 80
  384.    character OUTPUT limit. This allows you to use a LOT of SLBBS color
  385.    codes or STATZ codes per line. To best use this feature you may need
  386.    to use a text editor that allows for 255 character lines. I use my
  387.    Turbo Pascal editor or my Borland C++ editor for this.  Please note
  388.    that after any output line from your STATZ.TXT file has printed 80
  389.    characters on the screen then further processing for that line is halted.
  390.    If for example you wish to add sound to the end of a line that has
  391.    already sent 80 characters to the screen then these sound codes
  392.    WILL BE IGNORED.
  393.  
  394.    SLBBS COLOR CODES that work with STATZ are as follows:
  395.  
  396.    \BI = BLINK
  397.    \BK = BLACK COLOR
  398.    \BL = BLUE COLOR
  399.    \BR = BROWN
  400.    \CY = CYAN COLOR
  401.    \DG = DARK GRAY COLOR
  402.    \GR = GREEN COLOR
  403.    \GY = GRAY COLOR
  404.    \IV = INVERSE TEXT
  405.    \LB = LIGHT BLUE COLOR
  406.    \LC = LIGHT CYAN COLOR
  407.    \LG = LIGHT GREEN COLOR
  408.    \LM = LIGHT MAGENTA COLOR
  409.    \LR = LIGHT RED COLOR
  410.    \MG = MAGENTA COLOR
  411.    \NO = NORMAL TEXT COLOR
  412.    \RD = RED COLOR
  413.    \WH = WHITE COLOR
  414.    \YE = YELLOW COLOR
  415.  
  416.    SLBBS OUTPUT CODES that work with Statz are available only to
  417.    Registered Statz Users and are as follows:
  418.  
  419.    \SB = Current Subboard                                   (REG. ONLY)
  420.    \FD = Current File Directory                             (REG. ONLY)
  421.    \%A = User's BBS Access Level                            (REG. ONLY)
  422.    \%B = Current Baud Rate                                  (REG. ONLY)
  423.    \%C = Sysop 'Chat Available' status (Y or N)             (REG. ONLY)
  424.    \%F = User's FILES Access Level                          (REG. ONLY)
  425.    \%G = ANSI Graphics Mode (C, M, or N)                    (REG. ONLY)
  426.    \%K = User's First Name                                  (REG. ONLY)
  427.    \%L = Time User Logged In (HH:MM)                        (REG. ONLY)
  428.    \%M = Amount of time left in current session in minutes  (REG. ONLY)
  429.    \%N = Current User's Name                                (REG. ONLY)
  430.    \%O = Node Number (Multiuser systems only)               (REG. ONLY)
  431.    \%P = Active Communications Port (0-4)                   (REG. ONLY)
  432.    \%S = BBS System Name (from STATZ.CNF)                   (REG. ONLY)
  433.    \%T = User's Time Limit, in minutes                      (REG. ONLY)
  434.    \%U = Current User's Name w/spaces replaced by underbars (REG. ONLY)
  435.  
  436.  
  437.    STATZ CODEZ are as follows as of THIS RELEASE.
  438.  
  439.    \XA = BBS NAME  ( from statz.cnf! )
  440.    \XB = USER NAME
  441.    \XC = MESSAGE AREA LEVEL
  442.  
  443.    Message Area Level will display a TEXT STRING denoting the current user's
  444.    level as set by YOU in config.sl2 if the following criteria are met:
  445.  
  446.    The Message Base level, Files level, and attributes must EXACTLY match
  447.    one of the NAMED levels from your config.sl2 file. If none of the
  448.    pre-configured levels in your config.sl2 file match this user, then the
  449.    numerical level value of their Message Base access is displayed.
  450.  
  451.    \XD = ALLOWABLE FILE TRANSFER RATIO
  452.  
  453.    The descriptive text for a current user with no file transfer ratio is
  454.    taken from the FILES= in the STATZ.CNF file. If the online user has
  455.    a ratio then ratio " to 1" is displayed.  The FILES2= entry in STATZ.CNF
  456.    allows you to change " to 1" to any string you'd like displayed in
  457.    reference to ratio.  An example might be using FILES2=:1 in your
  458.    STATZ.CNF file to have STATZ output ratio:1.
  459.  
  460.    \XE = CURRENT NODE
  461.    \XF = BAUD RATE
  462.    \XG = DAILY TIME LIMIT
  463.    \XH = REMAINING TIME TODAY
  464.  
  465.    The \XH remaining time today code displays the online caller's remaining
  466.    time today NOT TAKING INTO CONSIDERATION F9 and F10 time toggling.
  467.    This code is useful for displaying a user's remaining time today at login
  468.    or if you don't care to have the online user know you changed his/her/it's
  469.    time with your function keys.  Also useful if you consider that a user's
  470.    session time left may be less than the remaining time today.
  471.    Think of the \XH code as how much TOTAL TIME (all sessions combined and
  472.    not including F9/F10 time alterations) a user has left for that day.
  473.    Also useful for logoff information.
  474.  
  475.    \XI = BBS HELP LEVEL
  476.  
  477.    The \XI Help Level descriptive text output can be altered by the
  478.    HELP1=, HELP2=, and HELP3= STATZ.CNF entries.
  479.  
  480.    \XJ = ANSI MODE
  481.  
  482.    The \XJ Ansi Mode descriptive text output can be altered by the
  483.    MODE1=, MODE2=, and MODE3= STATZ.CNF entries.
  484.  
  485.    \XK = ANSI TYPE
  486.  
  487.    The \XK Ansi Type descriptive text output can be altered by the
  488.    ANSI1=, ANSI2=, and ANSI3= STATZ.CNF entries.
  489.  
  490.    \XL = TOTAL CALLS - THIS USER  
  491.    \XM = DATE THIS USER FIRST CALLED
  492.    \XN = KB UPLOADED               
  493.    \XO = KB DOWNLOADED
  494.    \XP = TRANSFER PROTOCOL
  495.  
  496.    The \XP protocol descriptive text for NO selected default protocol
  497.    and the first 3 (built-in) protocols can be altered by the PROTO1=,
  498.    PROTO2=, PROTO3=, and PROTO4= STATZ.CNF entries.  Protocols other
  499.    than the built in protocols are output directly from your CONFIG.SL2
  500.    entries.
  501.  
  502.    \XQ = PERCENTAGE OF TOTAL CALLS BY THIS USER        
  503.    \XR = TURN OFF SLBBS TYPE FLOW CONTROL (FORCE MODE) 
  504.    \XS = TURN ON SLBBS TYPE FLOW CONTROL               
  505.    \XT = TOTAL SYSTEM CALLS
  506.    \XU = DELAY (PAUSE) FOR 1/2 SECOND
  507.    \XV = DELAY (PAUSE) FOR 1 SECOND
  508.    \XW = CLEAR SCREEN
  509.  
  510.    The \XW clear screen command should only be used ONCE per text line
  511.    in your STATZ.TXT text file.  When the \XW clear screen code is
  512.    interpreted by STATZ the screen is correctly cleared for ALL user video
  513.    modes (TTY, ANSI MONO, ANSI COLOR) as well as on your end.
  514.    In addition, the statusline is re-drawn with current information.
  515.    the \XW clear screen command is your means to display several screens
  516.    of various lengths to your users.  Note that STATZ does not support
  517.    --more-- prompting but rather is a SCREEN ORIENTED door. If your STATZ.TXT
  518.    file sends more than 24 lines to a user before STATZ comes across an \XW
  519.    command in your STATZ.TXT file then the results will be rather weak.
  520.  
  521.    \XX = HALT/QUIT STATZ
  522.  
  523.    The \XX HALT code is interpreted by STATZ as STOP STATZ.  This code is
  524.    used to limit STATZ output anywhere YOU decide to.  STATZ will display
  525.    until the end of your input file unless you tell it to HALT at some place.
  526.  
  527.    User aborts of STATZ result in an errorlevel of 0 for DOS.
  528.    The \XX halt code CAN take an optional 3rd code character in the range
  529.    of 0 through 9 that will determine the DOS ERRORLEVEL when Statz shuts
  530.    down.  \XX7 for example will shut down Statz with an errorlevel of 7.
  531.    This is handy for batch file processing. 
  532.  
  533.    \XY = USER'S LOCATION  
  534.    \XZ = USER'S SYSTEM TYPE
  535.  
  536.  
  537.    \AA = SET INVERSE TEXT COLOR FOR CONFIGURED USER LEVEL
  538.                                                    (REGISTERED ONLY)
  539.    The \AA code sequence is followed by 3 parameter characters that denote
  540.    level and color.  Valid levels are fome A through Y and correspond to
  541.    the levels you can define as sysop in your config.sl2 file. The color
  542.    codes for foreground text are as follows:
  543.  
  544.    0 = BLACK, 1 = BLUE, 2 = GREEN, 3 = CYAN, 4 = RED, 5 = MAGENTA,
  545.    6 = BROWN, 7 = LIGHTGRAY, 8 = DARKGRAY, 9 = LIGHTBLUE, 10 = LIGHTGREEN,
  546.    11 = LIGHTCYAN, 12 = LIGHTRED, 13 = LIGHTMAGENTA, 14 = YELLOW,
  547.    15 = WHITE
  548.  
  549.    All numeric values under 10 should be prefixed with a 0.  For example,
  550.    you want to use black as your chosen text color.  You'd actually use
  551.    a Statz color code of 00.  Blue would be 01, etc.  Lightgreen would
  552.    NOT need a 0 in front.  In other words, all color codes should take
  553.    two spaces.
  554.  
  555.    The statusline is re-drawn IMMEDIATELY after use of this code using
  556.    the new colors.
  557.    The \AA code was included in STATZ to allow SYSOPS to easily see what
  558.    level user was currently on their system.  Used in conjunction with the
  559.    \AB code, you can set Statusline color combinations that correspond
  560.    to various levels defined on your own bbs.
  561.  
  562.    \AB = SET INVERSE BACKGROUND COLOR FOR CONFIGURED USER LEVEL
  563.                                                     (REGISTERED ONLY)
  564.    The \AB code sequence is followed by 3 parameter characters that denote
  565.    level and color.  Valid levels are A through Y and correspond to the
  566.    sysop definable levels in your config.sl2 file.  The color codes are
  567.    as follows:
  568.  
  569.    0 = BLACK, 1 = BLUE, 2 = GREEN, 3 = CYAN, 4 = RED, 5 = MAGENTA,
  570.    6 = BROWN, 7 = WHITE.
  571.  
  572.    The same guidelines used in color code notation should be used with the
  573.    \AB code as are used with the \AA code.
  574.  
  575.    Example : Set user with level A access to red background with white text.
  576.    This uses both the \AA and \AB codes.
  577.  
  578.    \AAA15\ABA04
  579.  
  580.    The statusline is re-drawn IMMEDIATELY after use of this code using
  581.    the new colors.
  582.  
  583.    \AC = HANG UP LINE FOR CONFIGURED USER LEVEL     (REGISTERED ONLY)
  584.  
  585.    The \AC code takes characters A through Y as parameters to hang up
  586.    the line.  The A through Y parameters correspond to the 25 Sysop
  587.    configurable user levels definable in your config.sl2 file.
  588.  
  589.    \AD = HANG UP LINE FOR 300 BAUD CALLERS          (REGISTERED ONLY)
  590.    \AE = HANG UP LINE FOR 1200 BAUD CALLERS         (REGISTERED ONLY)
  591.    \AF = HANG UP LINE FOR 2400 BAUD CALLERS         (REGISTERED ONLY)
  592.    \AG = HANG UP LINE FOR 9600 BAUD CALLERS         (REGISTERED ONLY)
  593.    \AH = HANG UP LINE FOR BBS LEVEL + OR -          (REGISTERED ONLY)
  594.  
  595.    The \AH code allows you to set plus and minus ranges for hanging up
  596.    the phone line.  \AH100- would hang up on ALL callers from BBS level
  597.    100 down.  The \AH code takes 4 characters as parameters.  The first
  598.    3 of which are BBS level.  Note that the bbs level MUST be 3 characters
  599.    long.  For example, level 25 would be 025 and level 1 would be 001.
  600.    The fourth character is a + or - and effectively ranges the hangup code
  601.    to affect all callers at bbslevel+ or bbslevel-.
  602.  
  603.    \AI = TURN ON FLOW CONTROL BASED ON CONFIGURED USER LEVEL
  604.                                                     (REGISTERED ONLY)
  605.    \AJ = TURN OFF FLOW CONTROL BASED ON CONFIGURED USER LEVEL
  606.                                                     (REGISTERED ONLY)
  607.    The \AI and \AJ codes allow you to control SLBBS type flow for callers
  608.    based upon their level based on the Sysop adjusted levels in the
  609.    config.sl2 file.  These codes will allow toggling for any of 25
  610.    configured levels of users on your system.  They work like the \XR and
  611.    \XS codes except that the \XR and \XS codes are global and the \AI and \AJ
  612.    are not.  Example: Turn on flow control for user at level C = \AIC
  613.    Example: Turn off flow control for user at level L = \AJL.
  614.  
  615.    \AK = FLOW CONTROL ON FOR 300 BPS CALLERS        (REGISTERED ONLY)
  616.    \AL = FLOW CONTROL OFF FOR 300 BPS CALLERS       (REGISTERED ONLY)
  617.    \AM = FLOW CONTROL ON FOR 1200 BPS CALLERS       (REGISTERED ONLY)
  618.    \AN = FLOW CONTROL OFF FOR 1200 BPS CALLERS      (REGISTERED ONLY)
  619.    \AO = FLOW CONTROL ON FOR 2400 BPS CALLERS       (REGISTERED ONLY)
  620.    \AP = FLOW CONTROL OFF FOR 2400 BPS CALLERS      (REGISTERED ONLY)
  621.    \AQ = FLOW CONTROL ON FOR 9600 BPS CALLERS       (REGISTERED ONLY)
  622.    \AR = FLOW CONTROL OFF FOR 9600 BPS CALLERS      (REGISTERED ONLY)
  623.    \AS = STATZ ABORTABLE BY CONFIG.SL2 LEVELED CALLER
  624.  
  625.    The \AS code takes a 3rd parameter from A through Y denoting the level
  626.    which you want this code to execute.  The A through Y levels correspond
  627.    to the levels YOU set in your bbs node configuration.  Example:
  628.    \ASD makes Statz output abortable by users at level D.
  629.  
  630.    \AT = STATZ NOT ABORTABLE BY CONFIG.SL2 CALLER
  631.  
  632.    The \AT code takes a 3rd parameter from A through Y that refers to the
  633.    level set in your configuration for this node.  Example:
  634.    \ATF makes Statz output non-abortable (user MUST view entire door or until
  635.    you remove this restriction with another code) for a user with an F
  636.    defined level for this node.
  637.  
  638.    \AU   = TURN LOGOFF QUOTES GATHERING ON BASED ON CONFIG.SL2 LEVELS
  639.                                                     (REGISTERED)
  640.  
  641.    \AV   = TURN LOGOFF QUOTES GATHERING OFF BASED ON CONFIG.SL2 LEVELS
  642.                                                     (REGISTERED)
  643.  
  644.    The \AU and \AV codes toggle the state of the LOGOFF QUOTES gathering
  645.    flag based upon levels configured in your CONFIG.SL2 file.  Both these
  646.    codes take a 3rd parameter (A - Y) that denotes the level you want to
  647.    switch quotes on or off for.  Example : \AVL turns off quotes gathering
  648.    for level L callers.
  649.  
  650.    \AW = TURN LOGOFF QUOTES GATHERING ON            (REGISTERED)
  651.    \AX = TURN LOGOFF QUOTES GATHERING OFF           (REGISTERED)
  652.    \AY = TURN LOGOFF QUOTES GATHERING ON BASED ON BBS LEVEL
  653.                                                     (REGISTERED)
  654.    \AZ = TURN LOGOFF QUOTES GATHERING OFF BASED ON BBS LEVEL
  655.                                                     (REGISTERED)
  656.  
  657.    The \AY and \AZ codes take a parameter of 4 characters that are as
  658.    follows: Example: \AZ040+ will turn OFF quotes gathering for callers
  659.    at bbs level 40 and UP.  \AY200- will turn quotes gathering ON for
  660.    callers with a BBS level of 200-.  Like all Statz codes that use the
  661.    + or -, you must include 3 numeric characters that represent the bbs
  662.    level.  Level 1 would be 001, level 43 would be 043, and level 111
  663.    would be 111, for examples.
  664.  
  665.    \BA = USER'S ELAPSED TIME FOR THIS CALL
  666.    \BB = IF USER ABORTS GO TO NEXT DEFINED SCREEN          
  667.    \BC = IF USER ABORTS THEN ABORT STATZ DOOR (default)     
  668.    \BD = SEND ^G BELL TO THE ONLINE CALLER
  669.    \BE = PLAY THE NOW-CLASSIC STATZ TRI-TONE CONCERTO
  670.    \BF = PLAY THE PETER GUNN THEME SONG
  671.    \BG = SET FREQUENCY FROM 1 TO 65535 FOR NOTE AND SOUND/PLAY NOTE
  672.  
  673.    The \BG code requires the correct input to function properly.
  674.    The format is \BGxxxxx with the xxxxx being an example for a 5 digit
  675.    number.  If the number of the frequency you wish to use is for example
  676.    99 then you should use 00099 - for the frequency of 1000 use 01000.
  677.    There should be no spaces between the \BG and the numbers.  1000 would
  678.    be \BG01000 and 99 would be \BG00099.
  679.  
  680.    \BH = SET DURATION (DELAY) FROM 1 to 65355 MILLISECONDS
  681.  
  682.    The \BH code requires correct input to function properly.
  683.    The format is \BHxxxxx with the xxxxx being an example for a 5 digit
  684.    number.  If the number of the delay you wish to use is for example
  685.    88 then you should use 00088 - for the delay of 1000 use 01000.
  686.    There should be no spaces between the \BH and the numbers.  1000 would
  687.    be \BH01000 and 88 would be \BH00088.
  688.  
  689.    \BJ = STOP SOUND
  690.  
  691.    If you don't use this code after using the \BG and \BH codes I can
  692.    guarantee you'll be wishing you had! <grin>  Unless, of course, your
  693.    PC speaker is disconnected.
  694.  
  695.    \BM = TOTAL SYSTEM CALLERS   (REGISTERED ONLY)
  696.  
  697.    The \BM code REQUIRES that the \ZA USERFILE PROCESSING CODE BE USED
  698.    PRIOR TO the \BM code being used.  The data the \BM code outputs is
  699.    found by the \ZA userfile processing.
  700.  
  701.    \BN = FREE DISK SPACE        (REGISTERED ONLY)
  702.  
  703.    The \BN code takes 2 additional parameters in it's construction.  These
  704.    are the DRIVE SPECIFICATION and the OUTPUT FORMAT.  Valid drive
  705.    specifications in Statz are 0 through 9.  If 0 is used then Statz will
  706.    return info on the CURRENT drive - whatever it is.  Drive specifications
  707.    1 through 9 correspond to drives A through I.  A=1, B=2, C=3, D=4, E=5,
  708.    F=6, G=7, H=8, I=9.  The second parameter is the OUTPUT FORMAT code.
  709.    Valid output format codes are 0, 1, and 2.  An output format code of 0
  710.    will output free disk space in bytes.  An output format code of 1 will
  711.    output free disk space in kilobytes and an output format code of 2 will
  712.    deliver the free space in megabytes.  Example \BN02 will show the free
  713.    disk space of the current drive in megabytes.  Example \BN32 will show
  714.    the free disk space of drive C in kilobytes.  Note that a kilobyte is
  715.    1024 bytes and not 1000.  Useful for file area STATUS command output.
  716.  
  717.    \BO = PERCENTAGE OF DISK SPACE FREE  (REGISTERED ONLY)
  718.  
  719.    The \BO code will display the free disk space in a percentage format
  720.    as compared to the total disk space/size.  The \BO code works on the
  721.    drive selected by the code parameter supplied by you to \BO.
  722.    \BO0 would show percentage of space remaining on the current drive.
  723.    \B03 would work on drive c:.  Valid parameters are 1 through 9.
  724.  
  725.    \BP = TOTAL DISK SPACE     (REGISTERED ONLY)
  726.  
  727.    The \BP code displays TOTAL DISK SPACE using the same code syntax as the
  728.    \BN code described above.  It takes the same two parameters and works in
  729.    exactly the same way.  Example \BP02 will display TOTAL DISK SPACE
  730.    on the current drive in megabytes.  Useful for file area STATUS command.
  731.  
  732.    \BQ = PERCENTAGE OF TOTAL DISK SPACE USED  (REGISTERED ONLY)
  733.  
  734.    The \BQ code displays USED disk space in a percentage format.  It takes
  735.    a one character drive specifier just like \BO does.
  736.  
  737.    \BS = HANG UP PHONE                (REGISTERED ONLY)
  738.  
  739.    The \BS code is useful for login if the Sysop is performing maintainence
  740.    and wishes to temporarily close message/file access while still allowing
  741.    users on the bbs to possibly read an explanation of why the system is
  742.    down.  It's also useful for a GOODBYE replacement without possibility
  743.    of the caller using the quotes and/or logoff doors.  Or more obviously,
  744.    for logoff doors.
  745.  
  746.    \BW = SET FOREGROUND COLOR FOR STATUSLINE
  747.  
  748.    The \BW code is used to set a foreground color for the statusline
  749.    when you're using the other codes that change the colors of the
  750.    statusline depending on the online user's level.  The \BW code is
  751.    used to ZERO OUT or RESET so that if your last caller set the color
  752.    to (for example) red, you can use \BW to set it to whatever you
  753.    want for a default.  This code is not necessary in ALL uses of
  754.    the various statusline color codes, but is included in order to allow
  755.    you more freedom in your use of these statusline color codes.
  756.  
  757.    Color Codes:
  758.  
  759.    0 = BLACK, 1 = BLUE, 2 = GREEN, 3 = CYAN, 4 = RED, 5 = MAGENTA,
  760.    6 = BROWN, 7 = LIGHTGRAY, 8 = DARKGRAY, 9 = LIGHTBLUE, 10 = LIGHTGREEN,
  761.    11 = LIGHTCYAN, 12 = LIGHTRED, 13 = LIGHTMAGENTA, 14 = YELLOW,
  762.    15 = WHITE
  763.  
  764.    \BX = SET BACKGROUND COLOR FOR STATUSLINE
  765.  
  766.    The \BX code is used like the \BW code except that it changes the
  767.    statusline background color.
  768.  
  769.    Color Codes:
  770.  
  771.    0 = BLACK, 1 = BLUE, 2 = GREEN, 3 = CYAN, 4 = RED, 5 = MAGENTA,
  772.    6 = BROWN, 7 = WHITE.
  773.  
  774.    \BY = SET STATUSLINE FOREGROUND COLOR BASED ON BBS LEVELS
  775.  
  776.    This code will set the TEXT foreground color on the statusline based
  777.    on bbs message levels.  An example would be \BY225+03, which would turn
  778.    the text color cyan for all users from level 225 and up.
  779.    \BY100-01 would turn the text color blue for users at level 100 and down.
  780.  
  781.    Color Codes:
  782.  
  783.    0 = BLACK, 1 = BLUE, 2 = GREEN, 3 = CYAN, 4 = RED, 5 = MAGENTA,
  784.    6 = BROWN, 7 = LIGHTGRAY, 8 = DARKGRAY, 9 = LIGHTBLUE, 10 = LIGHTGREEN,
  785.    11 = LIGHTCYAN, 12 = LIGHTRED, 13 = LIGHTMAGENTA, 14 = YELLOW,
  786.    15 = WHITE
  787.  
  788.    \BZ = SET STATUSLINE BACKGROUND COLOR BASED ON BBS LEVELS
  789.  
  790.    The \BZ code changes the background color of the statusline based on
  791.    bbs levels.  \BZ200-05 would turn the statusline background color to
  792.    magenta for callers at level 200 or less.   \BZ001+00 would set the
  793.    statusline background to black for all users with a bbs level of
  794.    1 and over.
  795.  
  796.    Color Codes:
  797.  
  798.    0 = BLACK, 1 = BLUE, 2 = GREEN, 3 = CYAN, 4 = RED, 5 = MAGENTA,
  799.    6 = BROWN, 7 = WHITE.
  800.  
  801.    \DA = CURRENT DATE IN MMM/DD/YY (USA) FORMAT  
  802.    \DB = CURRENT DATE IN DD-MMM-YY (EUROPEAN) FORMAT  
  803.    \DC = CURRENT DATE IN MM/DD/YYYY (FULL YEAR) FORMAT  
  804.    \DD = CURRENT DATE IN DD AAA YY (ABBREVIATED MONTH) FORMAT 
  805.    \DE = CURRENT DATE IN LONG FORMAT (ie: January 12, 1957) 
  806.    \DF = CURRENT TIME IN 12 HOUR FORMAT - AM OR PM APPENDED 
  807.    \DH = CURRENT TIME IN MILITARY (24 HOUR) FORMAT
  808.    \DI = PRESS RETURN (IN NODE COLORS - WAITS FOR CARRIAGE RETURN)
  809.    \DJ = MAXIMUM NUMBER OF NODES ON THE SYSTEM
  810.    \DK = LAST SUBBOARD ACCESSED BY THIS USER
  811.    \DL = USER'S PHONE NUMBER                            
  812.    \DM?? = MOVE TO COLUMN ??
  813.  
  814.    The \DM?? tells STATZ to move to the ?? numbered column on the current
  815.    screen row.  Columns are numbered 1 through 80 with 1 being the left-
  816.    most column.  You CANNOT move LEFT of your current position.
  817.    The \DM?? command allows you to pinpoint the starting area of the next
  818.    text string to be output by STATZ.  It's also useful for formatting
  819.    blocks of inverse color without messing up TTY (non-ansi) callers.
  820.    By being able to pinpoint output with \DM?? you can effectively plan
  821.    screen output regardless of the length of variable length strings
  822.    output by STATZ.  For example say you have a line that you'd like STATZ
  823.    to output for all users and you want something (like maybe a colored
  824.    border on screen or some info) to ALWAYS start at column 55...
  825.    simply use \DM55 and the NEXT string output by STATZ will start at column
  826.    55.  For numbers less than 10 please note that you must preceed the number
  827.    with a 0.  For example column 9 would be \DM09, column 5 would be \DM05.
  828.    The \DM?? command allows for ALL USER modes of output.  No matter what
  829.    you build with STATZ.TXT for STATZ to output, it will always be correctly
  830.    sent to the caller.  The \DM?? command moves even TTY callers to the
  831.    correct screen position.
  832.  
  833.    \DN = PRESS RETURN (WAITS FOR CARRIAGE RETURN)
  834.  
  835.    The \DN command is similar to the \DI command except that it allows you
  836.    to configure your own 'Press [RETURN]:' prompts.  Make your STATZ output
  837.    'Slam that RETURN key' or whatever you like.  Use \DN in your STATZ.TXT
  838.    file AFTER defining the prompt of your choice.  An example might be:
  839.    \lb\iv\wh[[RETURN]]\DN
  840.  
  841.    \ZA = PROCESS USERFILE  (REGISTERED ONLY)
  842.  
  843.    The \ZA code will process the userfile (USERS.SL2) to gather information
  844.    needed to display certain STATZ codes.  Since not all uses of STATZ will
  845.    require this file to be processed it is OPTIONALLY PROCESSED at YOUR will.
  846.    All the \Px and \Pxx codes require the \ZA code to be used prior to their
  847.    use.  In other words, the \P and \P% codes below WILL NOT WORK unless you
  848.    use \ZA in your STATZ.TXT file first.  This was made an option because,
  849.    depending on machine CPU and SPEED as well as userfile SIZE, this process
  850.    may take anywhere from a split second to a couple of years <grin>.  If
  851.    your STATZ application doesn't require the \ZA code then don't bother
  852.    using it - unless you need to use it as a delay routine!  This code
  853.    uses SHARE compatible file locking and unlocking for multi-node SLBBS
  854.    compatibility.  You might want to display a string such as :
  855.    "Processing Data - Please Wait" or "Formatting Harddisk - Please wait"
  856.    or "Informing Keebler Elves of your arrival, Boy!, Look at 'em go!"
  857.    Note that the \BM (total users) code also requires the \ZA processing.
  858.  
  859.    \PA = NUMBER OF USERS WITH NO DEFINED TRANSFER PROTOCOL  (REGISTERED ONLY)
  860.   \PA% = PERCENTAGE OF TOTAL USERS WITH NO DEFINED PROTOCOL (REGISTERED ONLY)
  861.    \PB = NUMBER OF USERS USING XMODEM                       (REGISTERED ONLY)
  862.   \PB% = PERCENTAGE OF TOTAL USERS THAT USE XMODEM          (REGISTERED ONLY)
  863.    \PC = NUMBER OF USERS USING XMODEM/CRC                   (REGISTERED ONLY)
  864.   \PC% = PERCENTAGE OF TOTAL USERS THAT USE XMODEM/CRC      (REGISTERED ONLY)
  865.    \PD = NUMBER OF USERS USING XMODEM/1K                    (REGISTERED ONLY)
  866.   \PD% = PERCENTAGE OF TOTAL USERS THAT USE XMODEM/1K       (REGISTERED ONLY)
  867.    \PE = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #1    (REGISTERED ONLY)
  868.   \PE% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #1     (REGISTERED ONLY)
  869.    \PF = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #2    (REGISTERED ONLY)
  870.   \PF% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #2     (REGISTERED ONLY)
  871.    \PG = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #3    (REGISTERED ONLY)
  872.   \PG% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #3     (REGISTERED ONLY)
  873.    \PH = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #4    (REGISTERED ONLY)
  874.   \PH% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #4     (REGISTERED ONLY)
  875.    \PI = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #5    (REGISTERED ONLY)
  876.   \PI% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #5     (REGISTERED ONLY)
  877.    \PJ = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #6    (REGISTERED ONLY)
  878.   \PJ% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #6     (REGISTERED ONLY)
  879.    \PK = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #7    (REGISTERED ONLY)
  880.   \PK% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #7     (REGISTERED ONLY)
  881.    \PL = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #8    (REGISTERED ONLY)
  882.   \PL% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #8     (REGISTERED ONLY)
  883.    \PM = NUMBER OF USERS USING SYSOP DEFINED PROTOCOL #9    (REGISTERED ONLY)
  884.   \PM% = PERCENTAGE OF TOTAL USERS THAT USE PROTOCOL #9     (REGISTERED ONLY)
  885.  
  886.    \PN = NUMBER OF USERS WITH EXPERT HELP LEVEL             (REGISTERED ONLY)
  887.   \PN% = PERCENTAGE OF TOTAL USERS AT EXPERT LEVEL          (REGISTERED ONLY)
  888.    \PO = NUMBER OF USERS WITH INTERMEDIATE HELP LEVEL       (REGISTERED ONLY)
  889.   \PO% = PERCENTAGE OF TOTAL USERS AT INTERMEDIATE LEVEL    (REGISTERED ONLY)
  890.    \PP = NUMBER OF USERS WITH NOVICE HELP LEVEL             (REGISTERED ONLY)
  891.   \PP% = PERCENTAGE OF TOTAL USERS AT NOVICE HELP LEVEL     (REGISTERED ONLY)
  892.  
  893.    \PQ = NUMBER OF USERS WITH GENERIC ANSI MODE             (REGISTERED ONLY)
  894.   \PQ% = PERCENTAGE OF TOTAL USERS WITH GENERIC ANSI        (REGISTERED ONLY)
  895.    \PR = NUMBER OF USERS WITH PROCOMM/TELIX ANSI MODE       (REGISTERED ONLY)
  896.   \PR% = PERCENTAGE OF TOTAL USERS WITH PROCOMM/TELIX ANSI  (REGISTERED ONLY)
  897.    \PS = NUMBER OF USERS WITH STANDARD ANSI MODE            (REGISTERED ONLY)
  898.   \PS% = PERCENTAGE OF TOTAL USERS WITH STANDARD ANSI       (REGISTERED ONLY)
  899.  
  900.    \FA = CHAT STATUS      (REGISTERED ONLY)
  901.  
  902.    The \FA code will output NOT if the Sysop is NOT available for chat mode
  903.    and "" (nothing) if the Sysop IS available for chat mode.  If the
  904.    AVAIL1= and/or AVAIL2= parameters in the STATZ.CNF file are defined then
  905.    they will override this default output.  This code is available to
  906.    Registered Users Only.
  907.  
  908.    \FB = SESSION TIME LIMIT                          (REGISTERED ONLY)
  909.  
  910.    The session time limit displays a user's session time LIMIT, not to be
  911.    confused with remaining session time.  This is a STATIC time that would
  912.    not change from day to day.  This code is not affected by the F9 or F10
  913.    keys.
  914.  
  915.    \FC = EXPIRATION DATE (MM-DD-YR)                  (REGISTERED ONLY)
  916.    \FE = TURN ON FLOW CONTROL w/ level adjustment    (REGISTERED ONLY)
  917.  
  918.    The \FE code will allow you to switch ON SLBBS-TYPE flow control based
  919.    on the online user's MESSAGE BASE LEVEL.  You can set flow on for users
  920.    from a certain level and UP  -[OR]- from a certain level and DOWN.
  921.    The \FE code takes 4 characters as an arguement.  The first 3 characters
  922.    are the message level you want to perform the cut-off at.  The 4th
  923.    character denotes ABOVE the chosen level (+) or BELOW (-).
  924.    \FE200+ would turn on slbbs-type flow control for all callers with a
  925.    message base level of 200 or above.  \FE010- would turn on slbbs-type
  926.    flow control for callers with a message base level of 10 or less.
  927.    Think of the \FE code as an \XS code with adjustments.
  928.  
  929.    \FF = TURN OFF FLOW CONTROL w/ level adjustment    (REGISTERED ONLY)
  930.  
  931.    The \FF code behaves exactly like the \FE code except it TURNS OFF the
  932.    SLBBS-TYPE flow control.  It will take the same arguements and work in
  933.    the same way.  The \FF code mimics the \XR code but allows for level
  934.    adjustments. \FF099+ would, for example, turn off flow control for
  935.    users with level 99 or higher.
  936.  
  937.    \FG = IF USER ABORTS THEN KILL STATZ w/ level adjustment
  938.                                                         (REGISTERED ONLY)
  939.    The \FG code allows you to set levels at which STATZ will allow the online
  940.    user to abort the door.  It works like the \BC code but takes a 4
  941.    character arguement like the \FE, \FF, and \FH codes.  An example:
  942.    \FG200+ would cause users with level 200 or higher to be able to abort
  943.    the STATZ door.
  944.  
  945.    \FH = IF USER ABORTS GO TO NEXT DEFINED SCREEN w/ level adjustment
  946.                                                        (REGISTERED ONLY)
  947.    The \FH code allows you to set levels at which STATZ will abort to
  948.    the next screen.  It behaves like the \BB code but it takes a 4 character
  949.    arguement like the \FE and \FF codes.  If you want everyone under level
  950.    122 to be able to abort to the next screen then use \FH121-.
  951.  
  952.  
  953.    \FI = KILL STATZ IF CALLER IS AT 300 BPS             (REGISTERED ONLY)
  954.  
  955.    The \FI code will shut down STATZ if the online caller is at 300 bps.
  956.  
  957.    \FJ = KILL STATZ IF CALLER IS AT 1200 BPS            (REGISTERED ONLY)
  958.    \FK = KILL STATZ IF CALLER IS AT 2400 BPS            (REGISTERED ONLY)
  959.    \FL = KILL STATZ IF CALLER IS AT 9600 BPS            (REGISTERED ONLY)
  960.    \FM = KILL STATZ IF CALLER IS LOCAL                  (REGISTERED ONLY)
  961.  
  962.    The \FM code is handy if you run a singlenode SLBBS and don't want to
  963.    wade through STATZ output each time you get on your board.  Once you have
  964.    the STATZ.TXT file the way you like it then add an \FM code and when
  965.    you login locally STATZ will know and abort itself back to the BBS.
  966.  
  967.    The \FI, \FJ, \FK, \FL, & \FM codes all take a 3rd numerical
  968.    parameter of 0 through 9.  The 0 through 9 denote errorlevel on exit.
  969.    In other words \FI9 will kill statz when a 300 bps user hits this code
  970.    while processing Statz and the DOS errorlevel will be 9.  This is handy
  971.    for batch file processing.  Note that standard user abort of Statz results
  972.    in a DOS errorlevel of 0.
  973.  
  974.  
  975.    \WA = LAST CALLER  (NAME OF LAST SYSTEM CALLER)
  976.    \WB = LAST QUOTE   (QUOTE LEFT BY LAST SYSTEM CALLER - IF ANY)
  977.    \WC = LAST CALLER LOCATION
  978.  
  979.    NODE COLOR CODES::::
  980.  
  981.    \NA = NORMAL TEXT COLOR
  982.    \NB = FOREGROUND COLOR FOR INPUT HIGHLIGHTING
  983.    \NC = BACKGROUND COLOR FOR INPUT HIGHLIGHTING
  984.    \ND = COLOR FOR COMMAND HIGHLIGHT
  985.    \NE = SUBBOARD INFORMATION COLOR
  986.    \NF = COLOR FOR HEADINGS
  987.    \NG = CHAT MODE COLOR
  988.    \NH = SPECIAL PROMPTS & MESSAGES COLOR
  989.    \NI = ERROR AND WARNING MESSAGES COLOR
  990.    \NJ = ALTERNATE SPECIAL COLOR
  991.    \NK = COLOR FOR PROMPTS
  992.  
  993.  
  994.  
  995. ::::::::::[ Getting at me! ]::::::::::
  996.  
  997.    I can be reached at the Old Hippie Software BBS @ 714 653-4802
  998.    Un-Registered STATZ users can visit us by using the STATZ USER account.
  999.    Simply enter STATZ USER at the name prompt and drop in for a visit!
  1000.    No password is required!
  1001.  
  1002.    We're online 24 hours a day at a locked DTE of 19200 running a 14400
  1003.    USRobotics HST modem.  The latest version of STATZ is available
  1004.    here all the time.
  1005.  
  1006.    For information regarding DISTRIBUTION SITES please see the
  1007.    DISTRIB.TXT file enclosed in this archive.
  1008.  
  1009. ::::::::::[ ADDITIONAL INFO ]::::::::
  1010.  
  1011.    Current versions of Searchlight BBS software as of this release of STATZ
  1012.    are as follows:
  1013.  
  1014.    Extended Single-Node Version 2.25S
  1015.    Extended Multi-Node Version 2.25M
  1016.  
  1017.    STATZ requires DOS 3.1 or GREATER to operate.
  1018.    STATZ requires that SLBBS.EXE be active to operate.
  1019.  
  1020.    STATZ uses SHARE if it's loaded AND your bbs is configured for more
  1021.    than one node.  If your BBS is configured for only 1 node and/or
  1022.    SHARE is not loaded, then file locking and unlocking are not processed.
  1023.    If you are running a multinode SLBBS with more than one node then SHARE
  1024.    SHOULD already be loaded.  In any case, STATZ ONLY uses SHARE compatible
  1025.    file locking and unlocking IF SHARE IS LOADED and you have more than
  1026.    one node available.
  1027.  
  1028.    Files included in this archive are as follows:
  1029.  
  1030.           STATZ.DOC ------- This documentation file
  1031.           STATZ.EXE ------- Executable file
  1032.           STATZ.CNF ------- STATZ Configuration file
  1033.           STATZ.TXT ------- STATZ text output file that YOU design
  1034.           ORDER.FRM ------- Order Form for STATZ registration
  1035.           STATZ.HIS ------- STATZ history
  1036.           NEW.TXT   ------- Sample \DM?? screen
  1037.           OFF.TXT   ------- Sample Music codes screen
  1038.           XXX.TXT   ------- Sample Login screen
  1039.           STATUS.TXT ------ Statz STATUS SLBBS command replacement
  1040.           STATZ2.TXT ------ Registered STATZ sample output screens
  1041.           CODES.LST ------- List of Statz Codes
  1042.           DISTRIB.TXT ----- DIstribution/Beta Test Sites Listing
  1043.           README.1ST ------ Last Minute Info & Changes on this release
  1044.  
  1045.    STATZ was written with Turbo Pascal 6.0 Professional.
  1046.  
  1047.    I assume no responsibility for ANYTHING that can, will, might, might not,
  1048.    does, did, could, or shall happen to you, your business, your computer,
  1049.    your life in general because of your using STATZ.
  1050.    I also assume no responsibility for any loss, gain, bad luck, crop losses,
  1051.    or anything else imaginable or unimaginable to anyone or anything under any
  1052.    circumstances at any time because of anyone or anything-- especially your
  1053.    use of STATZ. STATZ is extensively tested even prior to beta releases to
  1054.    insure that the chances of loss are at an absolute minimum.
  1055.  
  1056.    If you use STATZ please REGISTER it!
  1057.  
  1058.